gridpack::state_estimation::SEBranch Class Reference

#include <se_components.hpp>

Inheritance diagram for gridpack::state_estimation::SEBranch:
Inheritance graph
[legend]
Collaboration diagram for gridpack::state_estimation::SEBranch:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SEBranch (void)
 ~SEBranch (void)
bool matrixForwardSize (int *isize, int *jsize) const
bool matrixReverseSize (int *isize, int *jsize) const
bool matrixForwardValues (ComplexType *values)
bool matrixReverseValues (ComplexType *values)
void setYBus (void)
gridpack::ComplexType getYBus (void)
void load (const boost::shared_ptr< gridpack::component::DataCollection > &data)
gridpack::ComplexType getAdmittance (void)
gridpack::ComplexType getTransformer (SEBus *bus)
gridpack::ComplexType getShunt (SEBus *bus)
void setMode (int mode)
bool serialWrite (char *string, const int bufsize, const char *signal=NULL)
gridpack::ComplexType getComplexPower (std::string tag)
gridpack::ComplexType getRvrsComplexPower (std::string tag)
void addMeasurement (Measurement measurement)
void sortMeasurements (void)
void getVTheta (gridpack::state_estimation::SEBus *bus, double *v, double *theta)
void getV1V2Theta (gridpack::state_estimation::SEBranch *branch, double *v1, double *v2, double *theta)
void getPQ (SEBus *bus, double *p, double *q)
int matrixNumRows () const
int matrixNumCols () const
void matrixSetRowIndex (int irow, int idx)
void matrixSetColIndex (int icol, int idx)
int matrixGetRowIndex (int idx)
int matrixGetColIndex (int idx)
int matrixNumValues () const
void matrixGetValues (ComplexType *values, int *rows, int *cols)
int vectorNumElements () const
void vectorSetElementIndex (int ielem, int idx)
void vectorGetElementIndices (int *idx)
void vectorGetElementValues (ComplexType *values, int *idx)
void vectorSetElementValues (ComplexType *values)
void configureSE (void)

Constructor & Destructor Documentation

gridpack::state_estimation::SEBranch::SEBranch ( void   ) 

Simple constructor

gridpack::state_estimation::SEBranch::~SEBranch ( void   ) 

Simple destructor

Member Function Documentation

void gridpack::state_estimation::SEBranch::addMeasurement ( Measurement  measurement  ) 

Add a measurement to the branch

Parameters:
measurement a measurement struct that will be used to assign internal paramters
void gridpack::state_estimation::SEBranch::configureSE ( void   ) 

Configure branches with state estimation parameters. These can be used in other methods

gridpack::ComplexType gridpack::state_estimation::SEBranch::getAdmittance ( void   ) 

Return the complex admittance of the branch

Returns:
: complex addmittance of branch

Reimplemented from gridpack::ymatrix::YMBranch.

gridpack::ComplexType gridpack::state_estimation::SEBranch::getComplexPower ( std::string  tag  ) 

Return complex power for line element

Parameters:
tag describing line element on branch
Returns:
complex power
void gridpack::state_estimation::SEBranch::getPQ ( SEBus *  bus,
double *  p,
double *  q 
)

Return contribution to constraints

Parameters:
p,: real part of constraint
q,: imaginary part of constraint
gridpack::ComplexType gridpack::state_estimation::SEBranch::getRvrsComplexPower ( std::string  tag  ) 

Return complex power for line element at to end

Parameters:
tag describing line element on branch
Returns:
complex power
gridpack::ComplexType gridpack::state_estimation::SEBranch::getShunt ( SEBus *  bus  ) 

Return the contribution to a bus from shunts

Parameters:
bus,: pointer to the bus making the call
Returns:
: contribution to Y matrix from shunts associated with branches
gridpack::ComplexType gridpack::state_estimation::SEBranch::getTransformer ( SEBus *  bus  ) 

Return transformer contribution from the branch to the calling bus

Parameters:
bus,: pointer to the bus making the call
Returns:
: contribution from transformers to Y matrix
void gridpack::state_estimation::SEBranch::getV1V2Theta ( gridpack::state_estimation::SEBranch *  branch,
double *  v1,
double *  v2,
double *  theta 
)

Return contribution to constraints

Parameters:
v1,v2,: voltages at buses
theta,: angle difference between two buses
void gridpack::state_estimation::SEBranch::getVTheta ( gridpack::state_estimation::SEBus *  bus,
double *  v,
double *  theta 
)

Return contribution to constraints

Parameters:
v,: voltage at the other bus
theta,: angle difference between two buses
gridpack::ComplexType gridpack::state_estimation::SEBranch::getYBus ( void   ) 

Get values of YBus matrix. These can then be used in subsequent calculations

void gridpack::state_estimation::SEBranch::load ( const boost::shared_ptr< gridpack::component::DataCollection > &  data  )  [virtual]

Load values stored in DataCollection object into SEBranch object. The DataCollection object will have been filled when the network was created from an external configuration file

Parameters:
data,: DataCollection object contain parameters relevant to this branch that were read in when network was initialized

Reimplemented from gridpack::ymatrix::YMBranch.

bool gridpack::state_estimation::SEBranch::matrixForwardSize ( int *  isize,
int *  jsize 
) const [virtual]

Return size of off-diagonal matrix block contributed by the component for the forward/reverse directions

Parameters:
isize,jsize,: number of rows and columns of matrix block
Returns:
: false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBranch.

bool gridpack::state_estimation::SEBranch::matrixForwardValues ( ComplexType *  values  )  [virtual]

Return the values of the forward/reverse matrix block. The values are returned in row-major order

Parameters:
values,: pointer to matrix block values
Returns:
: false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBranch.

int gridpack::state_estimation::SEBranch::matrixGetColIndex ( int  idx  )  [virtual]

Get the column index corresponding to the columns contributed by this component

Parameters:
icol index of column contributed by this component (e.g. if component contributes 3 columns then icol is between 0 and 2)
Returns:
matrix index of column icol

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBranch::matrixGetRowIndex ( int  idx  )  [virtual]

Get the row index corresponding to the rows contributed by this component

Parameters:
irow index of row contributed by this component (e.g. if component contributes 3 rows then irow is between 0 and 2)
Returns:
matrix index of row irow

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBranch::matrixGetValues ( ComplexType *  values,
int *  rows,
int *  cols 
) [virtual]

Return values from a matrix block

Parameters:
values,: pointer to matrix block values
rows,: pointer to matrix block rows
cols,: pointer to matrix block cols

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBranch::matrixNumCols (  )  const [virtual]

Return number of columns in matrix from component

Returns:
number of columnsows from component

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBranch::matrixNumRows (  )  const [virtual]

Return number of rows in matrix from component

Returns:
number of rows from component

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBranch::matrixNumValues (  )  const [virtual]

Return the number of matrix values contributed by this component

Returns:
number of matrix values

Reimplemented from gridpack::component::GenMatVecInterface.

bool gridpack::state_estimation::SEBranch::matrixReverseSize ( int *  isize,
int *  jsize 
) const [virtual]

Return size of off-diagonal matrix block contributed by component. The values are for the reverse direction.

Parameters:
isize,jsize number of rows and columns of matrix block
Returns:
false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBranch.

bool gridpack::state_estimation::SEBranch::matrixReverseValues ( ComplexType *  values  )  [virtual]

Return the values for an off-diagonl matrix block. The values are for the reverse direction and are returned in row-major order.

Parameters:
values pointer to matrix block values
Returns:
false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBranch.

void gridpack::state_estimation::SEBranch::matrixSetColIndex ( int  icol,
int  idx 
) [virtual]

Set column indices corresponding to the columns contributed by this component

Parameters:
icol index of column contributed by this component (e.g. if component contributes 3 columns then icol is between 0 and 2)
idx matrix index of column icol

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBranch::matrixSetRowIndex ( int  irow,
int  idx 
) [virtual]

Set row indices corresponding to the rows contributed by this component

Parameters:
irow index of row contributed by this component (e.g. if component contributes 3 rows then irow is between 0 and 2)
idx matrix index of row irow

Reimplemented from gridpack::component::GenMatVecInterface.

bool gridpack::state_estimation::SEBranch::serialWrite ( char *  string,
const int  bufsize,
const char *  signal = NULL 
) [virtual]

Write output from branches to standard out

Parameters:
string (output) string with information to be printed out
bufsize size of string buffer in bytes
signal an optional character string to signal to this routine what about kind of information to write
Returns:
true if branch is contributing string to output, false otherwise

Reimplemented from gridpack::component::BaseComponent.

void gridpack::state_estimation::SEBranch::setMode ( int  mode  )  [virtual]

Set the mode to control what matrices and vectors are built when using the mapper

Parameters:
mode,: enumerated constant for different modes

Reimplemented from gridpack::ymatrix::YMBranch.

void gridpack::state_estimation::SEBranch::setYBus ( void   ) 

Set values of YBus matrix. These can then be used in subsequent calculations

Reimplemented from gridpack::ymatrix::YMBranch.

void gridpack::state_estimation::SEBranch::sortMeasurements ( void   ) 

Sort measurements so that they are in a consistent order

void gridpack::state_estimation::SEBranch::vectorGetElementIndices ( int *  idx  )  [virtual]

Get list of element indices from component

Parameters:
idx list of indices that component maps onto

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBranch::vectorGetElementValues ( ComplexType *  values,
int *  idx 
) [virtual]

Get a list of vector values contributed by this component and their indices

Parameters:
values list of vector element values
idx indices for the vector elements

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBranch::vectorNumElements (  )  const [virtual]

Return number of elements in vector coming from component

Returns:
number of elements contributed from component

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBranch::vectorSetElementIndex ( int  ielem,
int  idx 
) [virtual]

Set indices corresponding to the elements contributed by this component

Parameters:
ielem index of element contributed by this component (e.g. if component contributes 3 elements then ielem is between 0 and 2)
idx vector index of element ielem

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBranch::vectorSetElementValues ( ComplexType *  values  )  [virtual]

Transfer vector values to component

Parameters:
values list of vector element values

Reimplemented from gridpack::component::GenMatVecInterface.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on 3 Feb 2020 for GridPACK by  doxygen 1.6.1